'\" t
.TH cm2_listreleases 1 "19 September 2006" "Code Manager II"

.SH NAME
cm2 list releases \- List generated tag/releases for project

.SH SYNOPSIS
cm2 list releases [\fB--verbose\fP] [\fB--project\fP \fIX\fP] [\fB--mostrecent\fP \fIN\fP] [\fB--xml\fP]

.SH DESCRIPTION
The \fIcm2 list releases(1)\fP utility is used to display details of releases [tags] for
a particular project. By default it will should the tag name, the date of tagging, the
person who generated the tag and the short description for all releases for the project
for which the current working directory is a part of.

When returning results the format of the output will be similar to the following:

.TS
l.
Tag     Date              Creator   Description
======  ================  ========  =============================
0.0.1   2005/07/07 17:06  snedward  Test Release
0.0.2   2005/07/13 16:00  snedward  Updated functionality
0.0.3   2005/07/21 12:02  snedward  Yet more updates
0.0.4   2005/07/28 14:41  snedward  First pkg build
.TE

The format and content of the output can be modified via the support command
line arguments.

.SH ARGUMENTS
.TP 8
.B --verbose
Show more information regarding the generating of the release listing.
.TP
.B --project
Do not show details for the current directory, but instead show
all details for the project name specified. The name given can
be a project alias if necessary.
.TP
.B --mostrecent
Rather than showing details for all releases just show the most
recent ones. The number of releases to show must be specified.
.TP
.B --xml
Produce the results in an XML format rather than a more 
human-readable version. When this is used the output
format will be similar to the following:

.TS
l.
<?xml version="1.0" standalone="yes"?>
<releases>
  <release num="0.5.17" date="2006/09/05" time="12:11" 
    creator="snedward" desc="Improved rcs-pv2 migration"/>
  <release num="0.5.18" date="2006/09/08" time="14:03" 
    creator="snedward" desc="Minor bug fixes"/>
</releases>
.TE

.SH EXIT CODES
The \fIcm2 list releases(1)\fP follows UNIX standard practise:

.TP 4
.B 0
Details have been successfully returned.
.TP
.B >0
The command encountered an unexpected error.

.SH NOTES
If the back-end repository for the project being queried is the older RCS-based
scheme then this command may time some time to run for larger project which 
contain lots of releases.

.SH AUTHOR
The \fBCode Manager II\fP tool set was written by Simon Edwards, Proprius Consulting Ltd, (\fBwww.proprius.co.uk\fP).

.SH SEE ALSO
.BR cm2(1),
.BR cm2_info(1),
.BR cm2_tagrelease(1),
.BR cm2_tagremove(1).

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP.

